Admin APIs

API 1.0 Administrative APIs : deprecated

API Methods

★ Includes Example(s)
Can be used by Non-admin accounts

addActiveDirectoryUser

Add an Active Directory User

addFolderToDefaultTenant

Add folder to default tenant

addRolesToItem

Add roles to a content Item

addServerRoles

Add Security Roles to a Server

addUserToRole

Add Users to a Role

changeLicenseForUser

Change a User’s License Type

changeUserAdminType

Change a User’s Admin Type

createRole

Create a Security Role

createRoles

Create Security Roles from a list

createTenants

Create a Tenant

createTheme

Create a Theme

createUser

Create a new user

createUsers

Create New Users

deleteMaterializedModel

Delete a Materialized Model

deleteRole

Delete a security role

deleteTenant

Delete a Tenant

deleteTheme

Delete a Theme

deleteUser

Delete a user

duplicateTheme

Duplicate a Theme

exportTheme

Export a Theme

exportThemeById

Export a Theme

getAllItemsByUser

Get a User’s Content Items

getAllNonPrivateRoles

Get All Non-Private Roles

getAllNonPrivateRolesByTenant

Get all general security roles

getAllPrivateRolesByTenant

Get All User Roles by Tenant

getAllRoles

Get All User Roles

getAllRolesByUser

Gets all roles for a user

getAllTenants

getAllUsersByCurrentTenant

Get Tenant Users

getAvailiableTenantLicenseCount

Get License Counts for a Tenant

getConnectionStringId

getDataSourceForUser

Get a user's data sources

getDefaultTenant

Get the default tenant id

getExecutions

get Executions

getGroupsByRole

Get AD Groups in a Role

getLicenseCount

getLicenseCount2

getLicenseExpirationDate

Get License Expiration Date

getLicenseValidationStatus

Get License Status

getMaterializedRoles

getRole

Get a Security Role

getRolesByName

Get a User Role

getRolesForItem

Get a Content Item’s Roles

getServerByName

Get a Server ID

getTenantByName

Get Tenant by Name

getUser

Get a User

getUserLastLogin

getUserList

Gets all Users

getUserStatus

getUsersByName

Get Users by Name

getUsersByRole

Get Users by User Role

getVersion

Get the current application version.

importTheme

Import a Theme

searchAdGroups

Search AD Groups

searchAdGroupsForUser

Search User’s AD Groups

searchAdUsers

Search AD Users

searchAdUsersForGroup

Search AD Group Members

setDefaultTheme

Set a Default Theme

setItemAsFavorite

Add a content item to favorites

testDataSourceStatus

toggleEnableUser

Change User Status

updateUser

Update user details

updateUserRoles

Update a User’s Roles